home *** CD-ROM | disk | FTP | other *** search
/ BBS Toolkit / BBS Toolkit.iso / remote / ffgra102.zip / FFG.DOC < prev    next >
Text File  |  1992-03-15  |  11KB  |  217 lines
  1.  
  2.    ┌──────────────────────┬───────────────────────────────────────┬────────┐
  3.    │  Fast File Gen 1.02  │ A quick 'ALL FILES' generator for RA. │ M ▀▀▄  │
  4.    │  Copyright (C) 1992  ├───────────────────────────────────────┤   ▄▄ █ │
  5.    │          by          │ Maelstrom Online Services ■ 1:117/351 │  ████  │
  6.    │      Kit Cragin      ├───────────────────────────────────────┤ █ ▀▀   │
  7.    │  Maelstrom Software  │ 409-696-8722 HST/DS ■ 693-3753 2400bd │  ▀▄▄ S │
  8.    └──────────────────────┴───────────────────────────────────────┴────────┘
  9.  
  10.    DESCRIPTION
  11.    ─────────────────────────────────────────────────────────────────────────
  12.    Fast File Gen (FFG)  is a simple, but quick and powerful `ALL FILES' list
  13.    generator for Remote Access BBSes  (v1.10 up).  Don't let the short docu-
  14.    mentation fool you:  FFG has many useful features, and for $9 to register
  15.    it's an invaluable tool for the RA SysOp.
  16.  
  17.    FEATURES
  18.    ─────────────────────────────────────────────────────────────────────────
  19.    I created a variety of SysOp configurable features so the program will be
  20.    easy and flexible for you to use.
  21.  
  22.    ■ Generates lists of all file areas or just the ones you specify
  23.    ■ Handles read-only media, and creates index files of  file sizes so that
  24.        subsequent file listings do not need to access the CD-ROM at all
  25.    ■ MultiNode Aware (can be run while all users are online)
  26.    ■ Output is fully configurable with a number of replaceable codes
  27.    ■ Multiline descriptions are supported
  28.    ■ List format is: <filename> <size> <desciption> [<optional line>]
  29.    ■ Registered users'  needs such as file date support or new files tagging
  30.        can be custom made or incorporated into later releases.
  31.    ■ Handles comments that have been imbedded into FILES.BBS listings
  32.  
  33.    LIABILITY
  34.    ─────────────────────────────────────────────────────────────────────────
  35.    The author of this software,  Kit Cragin, assumes no liability whatsoever
  36.    for any damage or  loss of data done to any computer system which results
  37.    from the use of FFG -- Not that anything is likely to happen!
  38.  
  39.    RESTRICTIONS/REGISTRATION
  40.    ─────────────────────────────────────────────────────────────────────────
  41.    Feel free to pass this software on to others,  but make sure there are no
  42.    modifications of any kind. This software is shareware which means you can
  43.    use it for 30 days before you either register it, or discontinue use.
  44.  
  45.    To register, print REGISTER.ME and send a paltry $9 -- I can take my wife
  46.    wife out to dinner and make her happy :).
  47.  
  48.    CONFIGURATION
  49.    ─────────────────────────────────────────────────────────────────────────
  50.    I've designed FFG to be as simple and easy to set up as possible, because
  51.    I know many sysops hate to waste time writing batch files and testing new
  52.    programs. If you follow the steps below, FFG should run without a hitch.
  53.  
  54.    Configuration involves editing the included FFG.CFG file.  This file con-
  55.    tains several types of lines. Those that begin with a
  56.  
  57.       `;'  are comments and do not affect program operation.
  58.       `$'  are configuration parameters.
  59.       `!'  signal the end of a header or footer.
  60.  
  61.    Other lines are considered to be part of a header or footer.
  62.  
  63.    ┌─┐ Edit the configuration parameters.  Note that all parameters follow a
  64.    │1│ `$' in column 1, then a <space> then the parameter (0-38 characters).
  65.    └─┘
  66.          1   Path and filename of the output filelist (eg. ALLFILES.LST)
  67.  
  68.          2   Path to your CONFIG.RA file (Trailing \ is optional)
  69.  
  70.          3   Path to your FILES.RA  file (Trailing \ is optional)
  71.  
  72.          4   Template format of FileNames.  This is a combination of 8 upper
  73.              or lower case `X's, then a `.' or <space>, then 3 `X's.  Upper-
  74.              case X means the FileName's character will uppercase:
  75.  
  76.                         ┌──────────────┬────────────────┐
  77.                         │   TEMPLATE   │ EXAMPLE OUTPUT │
  78.                         ├──────────────┼────────────────┤
  79.                         │ XXXXXXXX.XXX │  FASTFILE.GEN  │
  80.                         │ Xxxxxxxx Xxx │  Fastfile Gen  │
  81.                         │ XxXxxxxx XXX │  FaStfile GEN  │
  82.                         └──────────────┴────────────────┘
  83.  
  84.          5   Format of the FileSize portion of the output.  This can be 1 of
  85.              these 4 types:
  86.                           ┌──────────┬────────────────┐
  87.                           │ TEMPLATE │ EXAMPLE OUTPUT │
  88.                           ├──────────┼────────────────┤
  89.                           │    k,    │ 2,331k         │
  90.                           │    b,    │ 2,312,456,889  │
  91.                           │    k     │ 2331k          │
  92.                           │    b     │ 2312456889     │
  93.                           └──────────┴────────────────┘
  94.  
  95.          6   The number of spaces between FileName and FileSize
  96.  
  97.          7   The number of spaces between FileSize and Description
  98.  
  99.          8   The number of spaces before FileName (usually 0)
  100.  
  101.          9   The number of spaces to indent multiline descriptions
  102.                                              ┌─┐
  103.         10   List of replaceable codes  (see │3│) with which to append  text
  104.              specified in #11 below.         └─┘
  105.  
  106.         11   The text that you want to append to certain  replaceable codes;
  107.              this is used to enhance the output.  For example in the FFG.CFG
  108.              file that came with this archive,  you'll see a `&&a' parameter
  109.              in the  area header and footer.  The next set of characters are
  110.              solidspace `▒'s. The &&a prints out the area name. So we get
  111.  
  112.                            ▒▒▒ New Uploads▒▒▒▒etc.
  113.  
  114.              Since the name `runs into'  the solid spaces,  I want to have a
  115.              <space> appended to the &&a. This will give me
  116.  
  117.                            ▒▒▒ New Uploads ▒▒▒etc.
  118.  
  119.              which looks a little nicer.  If you want 2 spaces, just specify
  120.              that. Simply put the text between `"'s (rabbit ears) eg: "  ".
  121.  
  122.         12   The list of areas that you want to add to your list.  If you're
  123.              doing all your file areas then put `ALL' on the line. If you're
  124.              doing a subset, separate the areas by spaces,  and sequences of
  125.              areas by a `-'. For example
  126.                                          1 4 7-10 12-15 18
  127.  
  128.         13   Do you want  imbedded comments to be generated with your list?
  129.              Enter  YES or NO here.  Comments  are lines  that begin with a
  130.              <space> inside of FILES.BBS's or FILES.nnn's.
  131.  
  132.    ┌─┐ Edit each of the 4 header/footer areas  to your taste.  Refer to sec-
  133.    │2│ tion -3- for any  replaceable codes  that you might want to use.  The
  134.    └─┘ first header is the `title' or main header to the file list.  The 2nd
  135.        is the header added to the beginning of each file area.  The third is
  136.        the footer added to the bottom  of each file area.  The fourth is the
  137.        'summary' page appended to the end of the list.
  138.  
  139.        All header/footers have a maximum of 50 lines.  The only exception is
  140.        the footer page when being expanded by a `&&A' code.
  141.  
  142.    ┌─┐ Add the Replaceable Codes  in the header/footer areas (see -2- above)
  143.    │3│ as needed. The codes are replaced in `overtype' mode.  So if you have
  144.    └─┘ &&D (date) in a section of text below with a `D' in Secion -1-, #11:
  145.  
  146.                 │ =-= &&D -=-=-=-= │
  147.         you get
  148.                 │ =-= 03/07/92 =-= │
  149.  
  150.        The parameters are
  151.  
  152.        &&D - The current date in mm/dd/yy format
  153.        &&T - The current time in hh:mm:ss [am|pm] format
  154.  
  155.        &&a - The current file area's name   as specified in FILES.RA
  156.        &&n - The current file area's number as specified in FILES.RA
  157.        &&f - The number of files found in the area
  158.        &&s - The total size of files in the area (formatted as per Sec.1,#5)
  159.  
  160.        &&N - The total number of file areas processed
  161.        &&F - The total number of all the files in all areas
  162.        &&S - The total size   of all the files in all areas
  163.  
  164.        &&A - A special paramter which outputs 1 line for each file area. The
  165.              line contains the &&a &&f &&s sequences nicely formatted.  This
  166.              makes a nice summary for all your areas.
  167.  
  168.    RUNNING FFG
  169.    ─────────────────────────────────────────────────────────────────────────
  170.    Running FFG is simple.  Just switch to the FFG directory and type FFG, or
  171.    type the \full path\FFG on the commandline.  The FFG.CFG config file will
  172.    be loaded by default.  If you wish to use a different one, add that para-
  173.    meter to the commandline.  Here's a sample section of a nightly maintain-
  174.    ance batch file that generates 3 lists:
  175.  
  176.        REM #1 Generate list of ALL files on BBS
  177.        c:\ra\util\ffg\ffg
  178.        REM #2 Generate list of all adult files
  179.        c:\ra\util\ffg\ffg adult.cfg
  180.        REM #3 Generate list of #1-#2
  181.        c:\ra\util\ffg\ffg regular.cfg
  182.  
  183.    Note that each of the .CFGs contain the appropriate file areas to  gener-
  184.    ate and the appropriate  names of the output lists.  The .CFGs must be in
  185.    the same directory as FFG.EXE.
  186.  
  187.    REGISTERING FFG
  188.    ─────────────────────────────────────────────────────────────────────────
  189.    Registration is simple (not to mention appreciated).  There are 2 ways to
  190.    do it; you can choose the one that is easiest for you.
  191.  
  192.    ┌─┐ Call Maelstrom Online Services at 1:117/351
  193.    │1│ 409-696-8722, 764-6516, 693-3753 or 693-3617  & use the online regis-
  194.    └─┘ tration feature  (uses Visa/MasterCard/Discover).  You will receive a
  195.        key immediately!  This is the fastest method.
  196.  
  197.    ┌─┐ Print REGISTER.ME, fill it out & send check/cash/money order.  I will
  198.    │2│ send your registration key via Fido netmail,  if you are in the node-
  199.    └─┘ list. If not, I will send it US Mail.
  200.  
  201.    NOTES & SUPPORT
  202.    ─────────────────────────────────────────────────────────────────────────
  203.    For those of you with a CD-ROM drive,  FFG will create FILESIZE.nnn files
  204.    in the listpath directory (where your FILES.nnn files are stored) accord-
  205.    ing to CONFIG.RA.   Subsequent  file listings will  run much faster since
  206.    file sizes won't need to be determined from the CD-ROM.   Should you ever
  207.    need to rescan  the filesizes  (say if you sorted  FILES.40 in descending
  208.    order) just delete the FILESIZE.nnn file associated with each area that's
  209.    changed and rerun FFG.
  210.    ─────────────────────────────────────────────────────────────────────────
  211.    Need help? Contact me in Fido's RA_UTIL echo, netmail, on the BBS (see #s
  212.    above), via US Mail or bunji through my apartment window). Special thanks
  213.    go to  William Herrington  of  The SaddleBag BBS 1:374/38 for his help in
  214.    debugging FFG.
  215.    ─────────────────────────────────────────────────────────────────────────
  216.    Enjoy!
  217.